docs: Implement version selector with sphinx-multiversion#613
Merged
laughingman7743 merged 3 commits intomasterfrom Oct 18, 2025
Merged
docs: Implement version selector with sphinx-multiversion#613laughingman7743 merged 3 commits intomasterfrom
laughingman7743 merged 3 commits intomasterfrom
Conversation
This PR implements a version selector for the documentation using sphinx-multiversion. Users can now easily switch between different versions of the documentation. Changes: - Add sphinx-multiversion dependency to pyproject.toml - Configure sphinx-multiversion to build v3.x.x tags and master branch - Add dropdown-style version selector in sidebar (after CONTENTS) - Update GitHub Actions workflow to use 'make docs' command - Update Makefile to use sphinx-multiversion for docs target - Remove unused docs/Makefile and docs/make.bat files - Configure Furo theme options for source repository links The version selector is displayed as a dropdown below CONTENTS in the sidebar, matching the style of CONTENTS: heading. The root URL redirects to master branch documentation. Closes #612 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Change tag whitelist pattern from v3.x.x to vX.Y.Z to support future major versions (v4, v5, etc.) without configuration changes.
Add tag push trigger (v*) to documentation workflow so that new version documentation is built and deployed automatically when a new version is released.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Implements a version selector for the documentation using sphinx-multiversion, allowing users to easily switch between different versions of the documentation.
Changes
sphinx-multiversiondependency topyproject.tomlmake docscommanddocs/Makefileanddocs/make.batfilesUI/UX
The version selector is displayed as a dropdown below the CONTENTS section in the sidebar. The heading "VERSIONS:" matches the style of "CONTENTS:" for visual consistency.
Configuration
sphinx-multiversion settings:
GitHub Actions triggers:
v*pattern (new releases automatically trigger docs build)Test Plan
make docsproduces multi-version documentationScreenshots
Please review the deployed documentation after CI completes.
Closes #612
🤖 Generated with Claude Code